// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

#ifndef Events_MessageGroup_H_
#define Events_MessageGroup_H_

#include <Events_Message.h>
#include <memory>

/**\class Events_MessageGroup
 * \ingroup EventsLoop
 * \brief Message that allows to group messages and send them later as a group of messages.
 *
 * Loop detects such messages and accumulates them without sending. On "flush" loop sends it
 * as a group-message.
 */
class EVENTS_EXPORT Events_MessageGroup : public Events_Message
{

 public:

  //! Creates the message
  Events_MessageGroup(const Events_ID theID, const void* theSender = 0);
  //! do nothing in the destructor yet
  virtual ~Events_MessageGroup();

  //! Creates a new empty group (to store it in the loop before flush)
  virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  //! Allows to join the given message with the current one
  virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
};

#endif
